/*
 * Copyright (c) 2004-2025, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors 
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.datavalue;

import static java.util.Objects.requireNonNull;

import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import org.hisp.dhis.category.CategoryOptionCombo;
import org.hisp.dhis.common.UID;
import org.hisp.dhis.common.UsageTestOnly;
import org.hisp.dhis.dataelement.DataElement;
import org.hisp.dhis.organisationunit.OrganisationUnit;
import org.hisp.dhis.period.Period;

/** A record of the ID combination that points to a unique aggregate data value row. */
public record DataEntryKey(
    @Nonnull UID dataElement,
    @Nonnull UID orgUnit,
    @CheckForNull UID categoryOptionCombo,
    @CheckForNull UID attributeOptionCombo,
    @Nonnull String period)
    implements DataEntryId {

  public DataEntryKey {
    requireNonNull(dataElement);
    requireNonNull(orgUnit);
    requireNonNull(period);
  }

  @UsageTestOnly
  public DataEntryKey(
      @Nonnull DataElement dataElement,
      @Nonnull Period period,
      @Nonnull OrganisationUnit orgUnit,
      @CheckForNull CategoryOptionCombo categoryOptionCombo,
      @CheckForNull CategoryOptionCombo attributeOptionCombo) {
    this(
        UID.of(dataElement),
        UID.of(orgUnit),
        UID.of(categoryOptionCombo),
        UID.of(attributeOptionCombo),
        period.getIsoDate());
  }

  @Nonnull
  public DataEntryValue toDeletedValue() {
    return new DataEntryValue(
        0,
        dataElement,
        orgUnit,
        categoryOptionCombo,
        attributeOptionCombo,
        period,
        null,
        null,
        null,
        true);
  }
}
